Skip to main content

Fetch User Status

This endpoint retrieves the status of a specific user in the business API. The request should be made using an HTTP GET method to the specified URL, including the user's ID in the path and the API key and email as query parameters.

API Endpoint​

api/v1/business/user/{{userId}}/status?apikey=<API KEY>&email=<EMAIL ID>

Request Syntax​

POST api/v1/business/user/{{userId}}/status?apikey=<API KEY>&email=<EMAIL ID>

Request Body​

  • Content-Type:
    • application/x-www-form-urlencoded (form-data)
  • Parameters:
    • email: Caller’s EMAIL
    • apikey: API KEY

Example​

Sample Request​

curl --location 'https://alb-backend.msgkart.com/api/v1/business/user/<USER ID>/status?apikey=<API KEY>&email=<EMAIL ID>'

Response​

{
    "userStatus": "Available"
}
  • HTTP Status Code: 200 OK (successful), 4xx/5xx (error)
  • Response Body: JSON object containing user status details.

Types of Status​

  • Available
  • Busy
  • InCall
  • Away
  • Disabled

Error Handling​

  • Invalid credentials: 401 Unauthorized
  • Missing/invalid parameters: 400 Bad Request
  • Internal server error: 500 Internal Server Error